<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Jetson Inference: jetson-utils/devInput.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="NVLogo_2D.jpg"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Jetson Inference
   </div>
   <div id="projectbrief">DNN Vision Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('devInput_8h_source.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">devInput.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="devInput_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright (c) 2017, NVIDIA CORPORATION. All rights reserved.</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * copy of this software and associated documentation files (the &quot;Software&quot;),</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * to deal in the Software without restriction, including without limitation</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * the rights to use, copy, modify, merge, publish, distribute, sublicense,</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> * and/or sell copies of the Software, and to permit persons to whom the</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * Software is furnished to do so, subject to the following conditions:</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * The above copyright notice and this permission notice shall be included in</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * all copies or substantial portions of the Software.</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> * DEALINGS IN THE SOFTWARE.</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#ifndef __DEV_INPUT_H__</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor">#define __DEV_INPUT_H__</span></div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="devKeyboard_8h.html">devKeyboard.h</a>&quot;</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="devJoystick_8h.html">devJoystick.h</a>&quot;</span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="preprocessor">#include &lt;utility&gt;</span></div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="group__input.html#ga50538a4d144ab00657372f458f9c3cb4">   37</a></span>&#160;<span class="keyword">typedef</span> std::vector&lt; std::pair&lt;std::string, std::string&gt; &gt; <a class="code" href="group__input.html#ga50538a4d144ab00657372f458f9c3cb4">DeviceList</a>;</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;</div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classInputDevices.html">   44</a></span>&#160;<span class="keyword">class </span><a class="code" href="classInputDevices.html">InputDevices</a></div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;{</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;        <span class="keyword">static</span> <a class="code" href="classInputDevices.html">InputDevices</a>* <a class="code" href="classInputDevices.html#a3e09be2fb85b398317b7ce4825d7e08a">Create</a>();</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;        <a class="code" href="classInputDevices.html#aee59f4de36c7953b7aced9b4d0d8fe9e">~InputDevices</a>();</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;        <span class="keywordtype">bool</span> <a class="code" href="classInputDevices.html#a40fd94440d7d89fbfd96b84db63887ad">Poll</a>( uint32_t timeout=0 );</div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;</div><div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classInputDevices.html#ab4980776694d32de85b4ed9b956a9911">   65</a></span>&#160;        <span class="keyword">inline</span> <a class="code" href="classKeyboardDevice.html">KeyboardDevice</a>* <a class="code" href="classInputDevices.html#ab4980776694d32de85b4ed9b956a9911">GetKeyboard</a>()<span class="keyword"> const                      </span>{ <span class="keywordflow">return</span> <a class="code" href="classInputDevices.html#a667e29a70249c6760b63fadc18e5f742">mKeyboard</a>; }</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;</div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classInputDevices.html#adef03b03e7fc4519dacf48220d83a7e9">   70</a></span>&#160;        <span class="keyword">inline</span> <a class="code" href="classJoystickDevice.html">JoystickDevice</a>* <a class="code" href="classInputDevices.html#adef03b03e7fc4519dacf48220d83a7e9">GetJoystick</a>()<span class="keyword"> const                      </span>{ <span class="keywordflow">return</span> <a class="code" href="classInputDevices.html#a850a23a3141e106df63b35bd94c536d0">mJoystick</a>; }</div><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;        <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classInputDevices.html#ab67ffc55bf1814816ae735ce0290e66c">Enumerate</a>( <a class="code" href="group__input.html#ga50538a4d144ab00657372f458f9c3cb4">DeviceList</a>&amp; devices );</div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;</div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;        <span class="keyword">static</span> std::string <a class="code" href="classInputDevices.html#aa8a0bed652968f7ad9e48f5a5b828504">FindPathByName</a>( <span class="keyword">const</span> <span class="keywordtype">char</span>* name );</div><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;</div><div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;        <span class="keywordtype">void</span> <a class="code" href="classInputDevices.html#a53de9667014046b098706f119843f7f9">Debug</a>( <span class="keywordtype">bool</span> enabled=<span class="keyword">true</span> );</div><div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;</div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="keyword">protected</span>:</div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;        <span class="comment">// constructor</span></div><div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;        <a class="code" href="classInputDevices.html#a4acecf026f4b289c7bb30f983706e79a">InputDevices</a>();</div><div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;</div><div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="classInputDevices.html#a667e29a70249c6760b63fadc18e5f742">   91</a></span>&#160;        <a class="code" href="classKeyboardDevice.html">KeyboardDevice</a>* <a class="code" href="classInputDevices.html#a667e29a70249c6760b63fadc18e5f742">mKeyboard</a>;</div><div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="classInputDevices.html#a850a23a3141e106df63b35bd94c536d0">   92</a></span>&#160;        <a class="code" href="classJoystickDevice.html">JoystickDevice</a>* <a class="code" href="classInputDevices.html#a850a23a3141e106df63b35bd94c536d0">mJoystick</a>;</div><div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;</div><div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="classInputDevices.html#adba1404d096e9c71455fef530554dd3e">   94</a></span>&#160;        <span class="keywordtype">bool</span> <a class="code" href="classInputDevices.html#adba1404d096e9c71455fef530554dd3e">mDebug</a>;</div><div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;};</div><div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;</div><div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;</div><div class="ttc" id="classInputDevices_html_a850a23a3141e106df63b35bd94c536d0"><div class="ttname"><a href="classInputDevices.html#a850a23a3141e106df63b35bd94c536d0">InputDevices::mJoystick</a></div><div class="ttdeci">JoystickDevice * mJoystick</div><div class="ttdef"><b>Definition:</b> devInput.h:92</div></div>
<div class="ttc" id="devKeyboard_8h_html"><div class="ttname"><a href="devKeyboard_8h.html">devKeyboard.h</a></div></div>
<div class="ttc" id="devJoystick_8h_html"><div class="ttname"><a href="devJoystick_8h.html">devJoystick.h</a></div></div>
<div class="ttc" id="classInputDevices_html_ab4980776694d32de85b4ed9b956a9911"><div class="ttname"><a href="classInputDevices.html#ab4980776694d32de85b4ed9b956a9911">InputDevices::GetKeyboard</a></div><div class="ttdeci">KeyboardDevice * GetKeyboard() const</div><div class="ttdoc">Retrieve the keyboard device. </div><div class="ttdef"><b>Definition:</b> devInput.h:65</div></div>
<div class="ttc" id="classInputDevices_html_aa8a0bed652968f7ad9e48f5a5b828504"><div class="ttname"><a href="classInputDevices.html#aa8a0bed652968f7ad9e48f5a5b828504">InputDevices::FindPathByName</a></div><div class="ttdeci">static std::string FindPathByName(const char *name)</div><div class="ttdoc">Find /dev/input path by device name. </div></div>
<div class="ttc" id="classKeyboardDevice_html"><div class="ttname"><a href="classKeyboardDevice.html">KeyboardDevice</a></div><div class="ttdoc">Keyboard device. </div><div class="ttdef"><b>Definition:</b> devKeyboard.h:38</div></div>
<div class="ttc" id="classInputDevices_html_aee59f4de36c7953b7aced9b4d0d8fe9e"><div class="ttname"><a href="classInputDevices.html#aee59f4de36c7953b7aced9b4d0d8fe9e">InputDevices::~InputDevices</a></div><div class="ttdeci">~InputDevices()</div><div class="ttdoc">Destructor. </div></div>
<div class="ttc" id="classInputDevices_html_adef03b03e7fc4519dacf48220d83a7e9"><div class="ttname"><a href="classInputDevices.html#adef03b03e7fc4519dacf48220d83a7e9">InputDevices::GetJoystick</a></div><div class="ttdeci">JoystickDevice * GetJoystick() const</div><div class="ttdoc">Retrieve the gamepad device. </div><div class="ttdef"><b>Definition:</b> devInput.h:70</div></div>
<div class="ttc" id="classInputDevices_html_a53de9667014046b098706f119843f7f9"><div class="ttname"><a href="classInputDevices.html#a53de9667014046b098706f119843f7f9">InputDevices::Debug</a></div><div class="ttdeci">void Debug(bool enabled=true)</div><div class="ttdoc">Enable/disable verbose logging. </div></div>
<div class="ttc" id="classInputDevices_html_a40fd94440d7d89fbfd96b84db63887ad"><div class="ttname"><a href="classInputDevices.html#a40fd94440d7d89fbfd96b84db63887ad">InputDevices::Poll</a></div><div class="ttdeci">bool Poll(uint32_t timeout=0)</div><div class="ttdoc">Poll the devices for updates. </div></div>
<div class="ttc" id="classInputDevices_html_a667e29a70249c6760b63fadc18e5f742"><div class="ttname"><a href="classInputDevices.html#a667e29a70249c6760b63fadc18e5f742">InputDevices::mKeyboard</a></div><div class="ttdeci">KeyboardDevice * mKeyboard</div><div class="ttdef"><b>Definition:</b> devInput.h:91</div></div>
<div class="ttc" id="classJoystickDevice_html"><div class="ttname"><a href="classJoystickDevice.html">JoystickDevice</a></div><div class="ttdoc">Joystick device. </div><div class="ttdef"><b>Definition:</b> devJoystick.h:36</div></div>
<div class="ttc" id="classInputDevices_html_a3e09be2fb85b398317b7ce4825d7e08a"><div class="ttname"><a href="classInputDevices.html#a3e09be2fb85b398317b7ce4825d7e08a">InputDevices::Create</a></div><div class="ttdeci">static InputDevices * Create()</div><div class="ttdoc">Create device. </div></div>
<div class="ttc" id="group__input_html_ga50538a4d144ab00657372f458f9c3cb4"><div class="ttname"><a href="group__input.html#ga50538a4d144ab00657372f458f9c3cb4">DeviceList</a></div><div class="ttdeci">std::vector&lt; std::pair&lt; std::string, std::string &gt; &gt; DeviceList</div><div class="ttdoc">Typedef of device &lt;path, name&gt; pairs. </div><div class="ttdef"><b>Definition:</b> devInput.h:37</div></div>
<div class="ttc" id="classInputDevices_html_a4acecf026f4b289c7bb30f983706e79a"><div class="ttname"><a href="classInputDevices.html#a4acecf026f4b289c7bb30f983706e79a">InputDevices::InputDevices</a></div><div class="ttdeci">InputDevices()</div></div>
<div class="ttc" id="classInputDevices_html_adba1404d096e9c71455fef530554dd3e"><div class="ttname"><a href="classInputDevices.html#adba1404d096e9c71455fef530554dd3e">InputDevices::mDebug</a></div><div class="ttdeci">bool mDebug</div><div class="ttdef"><b>Definition:</b> devInput.h:94</div></div>
<div class="ttc" id="classInputDevices_html_ab67ffc55bf1814816ae735ce0290e66c"><div class="ttname"><a href="classInputDevices.html#ab67ffc55bf1814816ae735ce0290e66c">InputDevices::Enumerate</a></div><div class="ttdeci">static void Enumerate(DeviceList &amp;devices)</div><div class="ttdoc">Scan /dev/input for devices. </div></div>
<div class="ttc" id="classInputDevices_html"><div class="ttname"><a href="classInputDevices.html">InputDevices</a></div><div class="ttdoc">Input device manager. </div><div class="ttdef"><b>Definition:</b> devInput.h:44</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_54a0acf6da04fe2ed9410b4c6369bc5d.html">jetson-utils</a></li><li class="navelem"><a class="el" href="devInput_8h.html">devInput.h</a></li>
    <li class="footer">Generated on Fri Jun 21 2019 16:23:15 for Jetson Inference by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
